/*
 * File     : StructureLifetimeManagedList.java
 * Created  : 26 Apr 2011
 *
 * Copyright © 2011 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni.internal.structure;

import com.googlecode.dni.internal.DniInternal;
import com.googlecode.dni.type.LifetimeManagedList;
import com.googlecode.dni.type.Pointer;
import com.googlecode.dni.type.structure.Structure;
import com.googlecode.dni.type.structure.StructureFactory;

/**
 * Implementation of {@link LifetimeManagedList} for {@link Structure}s.
 *
 * @param <E>
 *            the element type
 *
 * @author Matthew Wilson
 */
final class StructureLifetimeManagedList< E extends Structure > extends StructureList< E >
    implements LifetimeManagedList< E >
{

    /**
     * Creates a new instance, allocating memory.
     *
     * @param structureType
     *            the structure type
     * @param factory
     *            the structure factory
     * @param structureSize
     *            the size of the structure
     * @param size
     *            the number of elements in the list
     */
    StructureLifetimeManagedList( final Class< E > structureType,
                                  final StructureFactory< E > factory,
                                  final int structureSize,
                                  final int size )
    {
        // don't let it create an AutoFree
        super( DniInternal.ALLOCATOR.allocate( structureSize * size ),
               structureType,
               factory,
               structureSize,
               size );
    }

    /**
     * Creates a new instance from an existing pointer.
     *
     * @param pointer
     *            the pointer
     * @param structureType
     *            the structure type
     * @param factory
     *            the structure factory
     * @param structureSize
     *            the size of the structure
     * @param size
     *            the number of elements in the list
     */
    StructureLifetimeManagedList( final Pointer pointer,
                                  final Class< E > structureType,
                                  final StructureFactory< E > factory,
                                  final int structureSize,
                                  final int size )
    {
        super( pointer, structureType, factory, structureSize, size );
    }

    /**
     * Creates from a region.
     *
     * @param parent
     *            the parent
     * @param fromIndex
     *            index of the first element (inclusive)
     * @param toIndex
     *            index of the last element (exclusive)
     */
    private StructureLifetimeManagedList( final StructureList< E > parent, final int fromIndex, final int toIndex )
    {
        super( parent, fromIndex, toIndex );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public LifetimeManagedList< E > subList( final int fromIndex, final int toIndex )
    {
        return new StructureLifetimeManagedList< E >( this, fromIndex, toIndex );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void free()
    {
        DniInternal.ALLOCATOR.free( pointer() );
    }

}
